Skip to content

Update README.md and UPGRADING.md for 3.0.0 release#243

Merged
Sinjo merged 3 commits intomasterfrom
sinjo-update-readme-pushgateway
Jan 28, 2022
Merged

Update README.md and UPGRADING.md for 3.0.0 release#243
Sinjo merged 3 commits intomasterfrom
sinjo-update-readme-pushgateway

Conversation

@Sinjo
Copy link
Copy Markdown
Member

@Sinjo Sinjo commented Jan 10, 2022

We've made a bunch of breaking changes recently, which will be part of
the 3.0.0 release. This commit updates our README to match the new API
in anticipation of that relese.


Fixes #240

@Sinjo Sinjo requested a review from dmagliola January 10, 2022 00:29
@Sinjo Sinjo force-pushed the sinjo-update-readme-pushgateway branch 2 times, most recently from 84c1efa to 4bd2e08 Compare January 10, 2022 00:36
Copy link
Copy Markdown
Collaborator

@dmagliola dmagliola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we update UPGRADING.md too with the push client changes?

@Sinjo
Copy link
Copy Markdown
Member Author

Sinjo commented Jan 10, 2022

Yeah, let's go for it. I was on the fence since we didn't for the last breaking release (2.0.0), but it seems like a nice thing to do for users.

@Sinjo Sinjo force-pushed the sinjo-update-readme-pushgateway branch from 0b78158 to 76d6677 Compare January 14, 2022 22:41
@Sinjo
Copy link
Copy Markdown
Member Author

Sinjo commented Jan 14, 2022

76d6677#r63911348

bruh

image

@Sinjo Sinjo force-pushed the sinjo-update-readme-pushgateway branch 8 times, most recently from fa79b34 to 87d7139 Compare January 18, 2022 01:31
Sinjo added 2 commits January 18, 2022 01:50
We've made a bunch of breaking changes recently, which will be part of
the 3.0.0 release. This commit updates our README to match the new API
in anticipation of that relese.

Signed-off-by: Chris Sinjakli <chris@sinjakli.co.uk>
Signed-off-by: Chris Sinjakli <chris@sinjakli.co.uk>
@Sinjo Sinjo force-pushed the sinjo-update-readme-pushgateway branch 6 times, most recently from d7999b7 to f58ab64 Compare January 23, 2022 17:31
@Sinjo
Copy link
Copy Markdown
Member Author

Sinjo commented Jan 23, 2022

@dmagliola I've pushed what I think is a complete set of notes on breaking changes in the 3.x.x series. Should be ready for a once over!

@Sinjo Sinjo changed the title Update README.md with changes to Prometheus::Client::Push Update README.md and UPGRADING.md for 3.0.0 release Jan 23, 2022
@Sinjo Sinjo force-pushed the sinjo-update-readme-pushgateway branch from f58ab64 to 588446c Compare January 28, 2022 02:03
@Sinjo Sinjo added this to the v3.0.0 milestone Jan 28, 2022
Comment thread UPGRADING.md Outdated
In line with changes we made for the 0.10.0 release (see below),
`Prometheus::Client::Push` now favours the use of keyword arguments for improved clarity
at the callsites. Specifically, the constructor now takes several keyword arguments rather
than relying entirely on keyword arguments. Where you would previously have written:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on positional arguments?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good spot!

Copy link
Copy Markdown
Collaborator

@dmagliola dmagliola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One tiny typo, otherwise :chefs_kiss:

Signed-off-by: Chris Sinjakli <chris@sinjakli.co.uk>
@Sinjo Sinjo force-pushed the sinjo-update-readme-pushgateway branch from 588446c to 3f4ed61 Compare January 28, 2022 14:22
@Sinjo Sinjo merged commit 9c896d0 into master Jan 28, 2022
@Sinjo Sinjo deleted the sinjo-update-readme-pushgateway branch January 28, 2022 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README.md with changes to pushgateway client

2 participants